Skip to content

dev: new way to fill the documentation #5986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 30 commits into from
Aug 11, 2025

Conversation

ldez
Copy link
Member

@ldez ldez commented Aug 9, 2025

The previous method for filling data inside the documentation was cumbersome.
It was modifying the Markdown files directly by replacing placeholders with the actual data.

Also, the script to update the documentation was not able to run when the placeholders were already filled.
You were forced to reset the changes made by the script before modifying the files.
But when you modified the same files as the script and reverted the changes, all the changes were reverted.

So it was a pain.

The placeholders are removed from the files; instead, I replaced placeholders with shortcodes and partials that use the data from the dedicated files.

Now, modifying and running locally the documentation is easier.

There is more information about the new way to fill out the documentation on the dedicated page inside the website.

It was not easy to create this new way to fill in the documentation.
The Hugo documentation is complex.
I found bugs inside the theme, and I had to fix them.

There are also a few improvements:

  • Better linter's authors section on the "thanks" page
  • Basic filtering inside the "linters" and "formatters" pages
  • Less aggressive image size for GitHub Actions illustrations inside the "installation" page
  • Add the description of the commands inside the "Command line" page

Fixes #4683

Follows #5965

@ldez ldez added this to the v2-unreleased milestone Aug 9, 2025
@ldez ldez added enhancement New feature or improvement area: docs labels Aug 9, 2025
@ldez ldez requested review from alexandear and bombsimon August 9, 2025 23:40
@ldez ldez force-pushed the feat/docs-goodbye-replacements branch 2 times, most recently from 83b0cf8 to 5d8ab53 Compare August 10, 2025 00:53
@ldez ldez force-pushed the feat/docs-goodbye-replacements branch from 5d8ab53 to 58fd2e3 Compare August 10, 2025 00:59
@ldez ldez force-pushed the feat/docs-goodbye-replacements branch from 58fd2e3 to dcc702e Compare August 10, 2025 01:02
Copy link
Member

@bombsimon bombsimon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Appreciate you documenting how these short codes work and their limitation.

Co-authored-by: Simon Sawert <[email protected]>
@ldez ldez merged commit aa726dc into golangci:main Aug 11, 2025
18 checks passed
@ldez ldez deleted the feat/docs-goodbye-replacements branch August 11, 2025 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs enhancement New feature or improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: support sorting / filtering linters table
3 participants